| name | value |
|---|---|
| partnerPersonTradeName | First GmbH |
| subscriberFamilyName | Firby |
| subscriberGivenName | Susan |
| subscriberEMailAddress | contact-admin@firstcontact.example.com |
| mailingList | first-gmbh-internal |
HTTP GET "/api/hs/office/persons?name=First+GmbH" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<tst-person_firbysusan>"` \
`# }`
=> status: 200 OK
[ {
"uuid" : "50df9b54-6221-4116-ad23-49d2876d8100",
"personType" : "LEGAL_PERSON",
"tradeName" : "First GmbH",
"salutation" : null,
"title" : null,
"givenName" : null,
"familyName" : null
} ]
In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.
HTTP GET "/api/hs/office/persons?name=Firby" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<tst-person_firbysusan>"` \
`# }`
=> status: 200 OK
[ {
"uuid" : "1cde1813-20bf-41ee-adfa-42c88cba1501",
"personType" : "NATURAL_PERSON",
"tradeName" : null,
"salutation" : null,
"title" : null,
"givenName" : "Susan",
"familyName" : "Firby"
} ]
In real scenarios there are most likely multiple results and you have to choose the right one.
HTTP GET "/api/hs/office/contacts?emailAddress=contact-admin@firstcontact.example.com" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<tst-person_firbysusan>"` \
`# }`
=> status: 200 OK
[ {
"uuid" : "df451bad-85e7-4d82-95df-3ab8ea3804ab",
"caption" : "first contact",
"postalAddress" : {
"country" : "Germany"
},
"emailAddresses" : {
"main" : "contact-admin@firstcontact.example.com"
},
"phoneNumbers" : {
"phone_office" : "+49 123 1234567"
}
} ]
In real scenarios there are most likely multiple results and you have to choose the right one.
HTTP POST "/api/hs/office/relations" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<tst-person_firbysusan>"` \
`# }` \
<<EOF
{
"type" : "SUBSCRIBER",
"mark" : "first-gmbh-internal",
"anchor.uuid" : "50df9b54-6221-4116-ad23-49d2876d8100", // Person: First GmbH
"holder.uuid" : "1cde1813-20bf-41ee-adfa-42c88cba1501", // Person: Susan Firby
"contact.uuid" : "df451bad-85e7-4d82-95df-3ab8ea3804ab" // Contact: contact-admin@firstcontact.example.com
}
EOF
=> status: 403 FORBIDDEN
{
"timestamp" : "2026-08-10 04:34:24",
"path" : "",
"statusCode" : 403,
"statusPhrase" : "Forbidden",
"message" : "ERROR: [403] new mark \"first-gmbh-internal\" for relation-type SUBSCRIBER may only be introduced by a global admin"
}
generated on 2026-08-10 04:34:24 for branch HEAD